home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / comm / xeno / bsytme19.lha / BusyTime.doc < prev    next >
Text File  |  1996-09-26  |  14KB  |  351 lines
  1. 960926
  2.                          Doc for BusyTime V1.9
  3.                         ~~~~~~~~~~~~~~~~~~~~~~~
  4.  
  5.  
  6. COPYRIGHT:
  7. ~~~~~~~~~~
  8. This program is XenoWare. If you own Xenolink Pro BBS you may use it
  9. freely and spread it to other users of Xenolink, as long as the archive
  10. remains in it's original state! Another requirement for using it more
  11. than two weeks is that you send me a netmail telling me you're using it!
  12.  
  13.  
  14. CHANGES V1.8 -> V1.9 (Released 960926):
  15. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16. * Had some complaints about the programme being hardcoded to produce the
  17.   textfiles in the BBS:Text/ drawer. The programme is now fully configurable on
  18.   this point. Add a line in the file XConfig:BusyTime/BusyTime.cfg before the
  19.   first one, ie the new line must be the first in the config. On this line you
  20.   state where you want the output to be located. This path is refered to as the
  21.   "OutputPath" in the rest of this document!
  22. * No bugfix, nothing really, just a tip! If you want to create two sets of
  23.   files, one with and one without colour for example, you could do like this:
  24.  
  25.   Create two sets of XConfig:BusyTime/BusyTime.cfg and call them BusyTime.cfg1
  26.   and BusyTime.cfg2. In the first you have the coloursettings, and in the second
  27.   you instead enter the colourcode  or perhaps nothing at all.
  28.   Then create a script that does something like this:
  29.   
  30.   Copy XConfig:BusyTime/BusyTime.cfg1 XConfig:BusyTime/BusyTime.cfg
  31.   BusyTime ALL
  32.   Move OutputPath:Busy1.txt ColourPath:Busy1.txt
  33.   Move OutputPath:Upload1.txt ColourPath:Upload1.txt
  34.   Move OutputPath:Download1.txt ColourPath:Download1.txt
  35.   Move OutputPath:BusyHour1.txt ColourPath:BusyHour1.txt
  36.   Move OutputPath:Busyweek1.txt ColourPath:Busyweek1.txt
  37.   Copy XConfig:BusyTime/BusyTime.cfg2 XConfig:BusyTime/BusyTime.cfg
  38.   BusyTime ALL NOSCAN
  39.  
  40.   Now you will have two sets of textfiles, one with and one without colour!
  41.   Of course, you don't have to move the file, a simple renaming of the files
  42.   would probably also do the trick!
  43.  
  44.  
  45. CHANGES V1.7 -> V1.8 (Released 960911):
  46. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47. * Sometimes for some reason, some of the data would be set to a negative
  48.   number. The bug is still there, but now it's not saved atleast.
  49.  
  50.  
  51. CHANGES V1.6 -> V1.7 (Released 960225):
  52. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  53. * Fixed a bug with "unsuccessful recieve".
  54. * Fixed a bug with "Incomplete file".
  55. * Speeded up reading of the logfile! No copying to RAM: nomore! The
  56.   programme now uses about 1MB of memory to accept a logfile of that
  57.   size. If the log is larger than this the programme may not work!
  58. * Speeded up the creation of all files!
  59. * Added support for re-logins.
  60. * Added stats on a weekly basis. Works exactly like the other bulletins.
  61.   Keyword = BSYWEEK.
  62.  
  63.  
  64. CHANGES V1.5 -> V1.6 (Released 960204):
  65. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  66. * Due to a counting error, the bottom part of the charts was too short.
  67. * Bars showing more than 50% in BUSY and BSYHOUR will be coloured red.
  68. * If run during an ongoing call, the lastline information saved will be
  69.   that of the previous call.
  70. * Added SCREEN keyword for presentation in a shellwindow.
  71. * Added Busytime.env possibility.
  72. * Moved logfiles and datafiles to XConfig:Busytime/Data/. If using older
  73.   version of Busytime, please create this path and move the files used
  74.   by Busytime in XLog: there.
  75. * Fixed a severe bug when running the programme for the first time. No
  76.   lastline information was saved, resulting in a re-read of old data
  77.   when run a second time.
  78.  
  79.  
  80. CHANGES V1.4 -> V1.5 (Released 960114):
  81. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  82. * I installed AFS on my Xenolink partition. I found that though AFS
  83.   speeded up most thing conserning diskhandling, it severly slowed down
  84.   the creation of files with Busytime! So I rewrote it to create the
  85.   files in RAM: first and then copy the result to disk rather than
  86.   creating them directly on disk.
  87.  
  88.  
  89. CHANGES V1.3 -> V1.4 (Released 960112):
  90. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  91. * Bug: Programme would save it's datafiles even if no new call was found.
  92. * Bug: Due to a division by zero, the programme would sometimes fail to
  93.   create the totalstats file.
  94. * Added ALL argument which causes all charts to be created with one
  95.   command.
  96. * Added NOSCAN argument, causing programme to not scan for new entries.
  97. * Added statistics for every hour. Keyword is BSYHOUR.
  98. * Cleaned up output to screen.
  99. * Moved header text to center of screen.
  100.  
  101.  
  102. CHANGES V1.2 -> V1.3 (Released 960103):
  103. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  104. * Big rewrite, changing configfile and way of running programme.
  105. * Added: Stats for uploads and downloads.
  106. * You now choose which stats to create, running with no args will only
  107.   update datafile.
  108.  
  109.  
  110. CHANGES V1.1 -> V1.2 (Released 951213):
  111. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  112. * BusyTime now copies the logfile to ram: before scanning it.
  113. * Buggfix: If no new calls were found, it would still show it found 1 call.
  114. * Buggfix: programme would redraw uploaded files even if there were no
  115.   bytes uploaded, ie. transfer aborted before it had even begun.
  116.  
  117.  
  118. CHANGES V1.0 -> V1.1 (Released 951122):
  119. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  120. * Rewrote it so it no longer has to shut down the logserver. Instead it
  121.   saves the last line to a file in XLOG:.
  122.   To make the programme NOT scan from the beginning (new lastline
  123.   recognition, remember) find the last answering line before the last
  124.   busytime logline in the call-x.log file and copy this line to the
  125.   lastline-file for that node. Did you REALLY get that? :) Or why not
  126.   erase the datafile for that node alltogether, and restart the damned
  127.   thing! :) Well, an answerline could look something like this:
  128.   
  129.   * 21-Nov-95 23:31:18 Answering modem
  130.   
  131.   Look for the last of those, that comes before the last one of these:
  132.   
  133.   | 11-14-1995 15:50:02 BusyTime
  134.  
  135. * Found a bug that counted unsuccessful uploads. I'm using UPFid, so
  136.   this may not work if you're not (using UPFid that is!). If a line
  137.   that looks like this:
  138.   
  139.   Zmodem receive unsuccessful
  140.   
  141.   is found, the last read uploaded bytes will not count. (hmmm, I think
  142.   I'll stop writing these docs! Drives me insane!)
  143.  
  144. * Added visual information about the progress of the logscan.
  145.  
  146.  
  147. V1.0 Released 951114
  148. ~~~~~~~~~~~~~~~~~~~~
  149.  
  150. WHAT IS IT:
  151. ~~~~~~~~~~~
  152. A programme to create...       * a file with statistics about what's
  153.                                  in the Call-x.log for sysop's pleasure.
  154.                                * a textfile to show the users the
  155.                                  upload statistics during last 75 days.
  156.                                * a textfile to show the users the
  157.                                  download statistics during last 75 days.
  158.                                * a textfile to show the users how
  159.                                  busy the BBS has been the last 75 days.
  160.                                * a textfile to show the users how busy
  161.                                  the BBS is every hour.
  162.                                * a textfile to show the users how busy
  163.                                  the BBS is every day of the week.
  164.  
  165.  
  166. INSTALLATION:
  167. ~~~~~~~~~~~~~
  168. I HATE writing these docs!
  169.  
  170. * Copy the BusyTime drawer with its content to Xconfig:
  171. * The programme will create five textfiles to show for the users called:
  172.  
  173.   OutputPath:Busy<n>.txt
  174.   OutputPath:Upload<n>.txt
  175.   OutputPath:Download<n>.txt
  176.   OutputPath:BusyHour<n>.txt
  177.   OutputPath:Busyweek<n>.txt
  178.  
  179.   where <n> is the nodenumber. Therefor, edit your bulletinmenu.src and add
  180.   the files on this format:
  181.   
  182.   CMD = "Your_Command"
  183.     {
  184.       TypeFile "Busy1.txt"
  185.     }
  186.  
  187. * Edit the configfiles:
  188.   TotalTemplate<n>: <n>=nodenumber
  189.     This file is the template for the totalstats file that will be
  190.     created in RAM: and you can edit it as you like. There are some
  191.     autoinserts you can use:
  192.  
  193.     %DATE - The date the following data was collected               [9]
  194.     %C    - Calls to BBS                                            [3]
  195.     %FC   - Fidonet calls to BBS                                    [3]
  196.     %U    - Uploaded files                                          [3]
  197.     %UB   - Uploaded bytes                                         [11]
  198.     %D    - Downloaded files                                        [3]
  199.     %DB   - Downloaded bytes                                       [11]
  200.     %FS   - Files send in fidonet session                           [3]
  201.     %FSB  - Bytes send in fidonet session                          [11]
  202.     %FR   - Files recieved in fidonet session                       [3]
  203.     %FRB  - Bytes recieved in fidonet session                      [11]
  204.     %UCPS - Average CPS while uploading (and recieving in fidonet)  [4]
  205.     %DCPS - Average CPS while downloading (and sending in fidonet)  [4]
  206.     %BT   - Busytime of BBS in HH:MM:SS                             [8]
  207.     %P    - Busytime of BBS in percent                              [2]
  208.     
  209.     The inserts will allways use the same space, wich is shown in
  210.     brackets above. For more information, please have a look at the
  211.     sample template. Remember to allways use capital letters!
  212.     
  213.   BusyTime.cfg
  214.     This file contains information about the textfile to create for the
  215.     users. There's one piece of data on each line and are as follows:
  216.  
  217.     Line     Type of data     Example          Note
  218.     ----     ------------     ------------     -----------------------------
  219.        1     OutputPath       Xenolink:Text/   Where the files should be located
  220.        2     DefaultColour                Colour for all other than bar
  221.        3     BarColour                    Colour of the bar
  222.        4     Barchar          #                Char to use for bar
  223.        5     FirstStart       50 BUSY          Explained later
  224.        6     FirstStop        30 BUSY          Explained later
  225.        7     FirstDwn         -5 BUSY          Explained later
  226.        8     SecondStart      28 BUSY          Explained later
  227.        9     SecondStop       0  BUSY          Explained later
  228.       10     SecondDwn        -2 BUSY          Explained later
  229.  
  230.     Using the last six lines would create a chart listed from 50% to 30%
  231.     with 5 less in each entry followed by 28% to 0% with 2 less in each
  232.     entry. Thus would it look like this:
  233.     
  234.     50
  235.     45
  236.     40
  237.     35
  238.     30
  239.     28
  240.     26
  241.     24
  242.     22
  243.     20
  244.     
  245.     and so on... Get the picture? It decreases with 5 until it gets to 30
  246.     where it starts decreasing with 2 for better accuracy.
  247.  
  248.     The keyword BUSY must be entered after each value that relates to
  249.     the busychart. Just like you have to enter UPLOAD after the numbers
  250.     relating to the uploadchart, DOWNLOAD after numbers relating to
  251.     the downloadchart, BSYHOUR after numbers relating to the
  252.     busyhourchart and BSYWEEK after numbers relating to the
  253.     busyweekchart.
  254.     You MUST have the values for a chart in the config if you're
  255.     planning to create such a chart. Otherwise you're bound to get an
  256.     errormessage!
  257.     For more info about the configfile, please look at the sample config
  258.     that came with the programme!
  259.  
  260.  
  261. USAGE:
  262. ~~~~~~
  263. BusyTime [TOTAL] [BUSY] [UPLOAD] [DOWNLOAD] [BSYHOUR]
  264.          [BSYWEEK] [ALL] [NOSCAN] [SCREEN] [NOENV] [node#]
  265.  
  266. By default, BusyTime creates no stats at all anymore! It only updates
  267. the datafile for the node entered, or for node 1 if no node is entered.
  268. Therefor you'll have to enter what statscharts to create.
  269.  
  270. "BusyTime BUSY UPLOAD"    would create busystats and uploadstats.
  271. "BusyTime TOTAL DOWNLOAD" would create totalstats and downloadstats.
  272. "BusyTime BUSY 2"         would create busystats for node 2.
  273. "BusyTime ALL"            would create all charts for node 1.
  274. "BusyTime ALL NOSCAN"     would create all charts without scanning.
  275. ...and so on!
  276.  
  277. Remember to allways put the nodenumber (if any) LAST!
  278.  
  279. After the logfile for that node has been scanned, the last answeringline
  280. will be saved in a file called "BusyTimeX.Lastline", where X is the
  281. nodenumber, letting BusyTime know where to start looking for new entries
  282. the next time the programme is run.
  283.  
  284. A logfile will be created in Xconfig:Busytime/Data/ with info and stats for
  285. the last 75 days (or less). This data will be used in the future for creating
  286. the charts...
  287.  
  288. The keyword BSYHOUR creates a textfile with statistics about the
  289. hourly busyness of your BBS. The programme logges even how many days the
  290. statistics is for, and uses this to compute the average. It even checks
  291. what time of day it is when the chart is created, and for entries after
  292. current time of day, it will continue to use yesterdays data.
  293. On the current hour, it will check how much time of the hour that's gone
  294. by, and recalculate to get an exact value!
  295.  
  296. The keyword SCREEN lets you view the charts directly in a shell window while
  297. creating the charts.
  298.  
  299. You can create a file in ENV: called Busytime.env containing all the
  300. keywords you like except the node#. If you have created this file you
  301. don't have to enter these keywords at the commandline.If you don't want to
  302. use the keywords in ENV: you can enter NOENV as a keyword.
  303.  
  304.  
  305. REQUIREMENTS:
  306. ~~~~~~~~~~~~~
  307. 2MB free memory
  308. LIBS:hbasic2.library
  309. XConfig:BusyTime/BusyTime.cfg
  310. XConfig:BusyTime/TotalTemplate<n>
  311. XConfig:BusyTime/Data/
  312.  
  313.  
  314. FOUND A BUG?:
  315. ~~~~~~~~~~~~~
  316. If you by any chance should find a bug or any other nasty creatures, you
  317. can reach me at my BBS:
  318.  
  319.   Absolut BBS -  +46 44 247248.        Open 24h, every day of the week,
  320.                                        every week of the year!
  321.  
  322. You can also reach me at the following address:
  323.  
  324.                                 Ulf Nilsson
  325.                                 Fadriften 53
  326.                                 S-296 33 Ahus
  327.                                    SWEDEN
  328.  
  329. (Not that I think anybody will actually write, but anyway...)
  330.  
  331. Or you can use my FidoNet address: 2:200/621.0
  332. Or why not my E-mail address     : uni@absolut.ct.se
  333.  
  334.  
  335. THANKS:
  336. ~~~~~~~
  337. ...for the next version of Xenolink with hopefully a LOT of bugfixes! :)
  338.  
  339.  
  340. EPILOGUE:
  341. ~~~~~~~~~
  342. You can always find updates (if there are any) on my BBS as soon as they are
  343. finished. The number is listed above.
  344.  
  345. Until the next door/util, see ya all in Microcosmos!
  346.  
  347. Greetings..    __  __    _   __
  348.                //  //    /\  //
  349.              _//  //    //\\//
  350.               \\_//lf _//  \/ilsson  ..SysOp Absolut BBS!
  351.